This page is part of the FHIR Specification (v1.2.0: STU 3 Draft). The current version which supercedes this version is 5.0.0. For a full list of available versions, see the Directory of published versions

• Content
• Detailed Descriptions
• Mappings
• XML
• JSON

F.19.1 StructureDefinition: QICore-ImmunizationRec

The official URL for this profile is:

http://hl7.org/fhir/StructureDefinition/qicore-immunizationrec

Profile of ImmunizationRecommendation for decision support/quality metrics. Defines the core set of elements and extensions for quality rule and measure authors.

This profile was published on Fri, Feb 27, 2015 00:00+1100 as a draft by Health Level Seven International (Clinical Quality Information - QICore).

F.19.1.1 Formal Views of Profile Content

Description of Profiles, Differentials, Snapshots, and how the XML and JSON presentations work.

• Text Summary
• Differential Table
• Snapshot Table
• XML Template
• JSON Template
• All

This structure is derived from ImmunizationRecommendation.

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

• http://hl7.org/fhir/StructureDefinition/qicore-patient
• http://hl7.org/fhir/StructureDefinition/qicore-organization
• http://hl7.org/fhir/StructureDefinition/qicore-immunization
• http://hl7.org/fhir/StructureDefinition/qicore-observation
• http://hl7.org/fhir/StructureDefinition/qicore-allergyintolerance

This structure is derived from ImmunizationRecommendation.

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation
patient	S	1..1	Reference(QICore-Patient)
recommendation		1..*	BackboneElement
date	S	1..1	dateTime
vaccineCode	S	1..1	CodeableConcept	Binding: Vaccine Administered Value Set (preferred)
doseNumber	S	0..1	positiveInt
protocol		0..1	BackboneElement
authority		0..1	Reference(QICore-Organization)
supportingImmunization		0..*	Reference(QICore-Immunization)
supportingPatientInformation		0..*	Reference(QICore-Observation | QICore-AllergyIntolerance)
Documentation for this format

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
meta	∑	0..1	Meta	Metadata about the resource
implicitRules	?! ∑	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: IETF BCP-47 (required)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	∑	0..*	Identifier	Business identifier
patient	S ∑	1..1	Reference(QICore-Patient)	Who this profile is for
recommendation	∑	1..*	BackboneElement	Vaccine administration recommendations
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
date	S ∑	1..1	dateTime	Date recommendation created
vaccineCode	S ∑	1..1	CodeableConcept	Vaccine recommendation applies to Binding: Vaccine Administered Value Set (preferred)
doseNumber	S ∑	0..1	positiveInt	Recommended dose number
forecastStatus	∑	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example)
dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (example)
value		1..1	dateTime	Recommended date
protocol		0..1	BackboneElement	Protocol used by recommendation
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
doseSequence		0..1	integer	Dose number within sequence
description		0..1	string	Protocol details
authority		0..1	Reference(QICore-Organization)	Who is responsible for protocol
series		0..1	string	Name of vaccination series
supportingImmunization		0..*	Reference(QICore-Immunization)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(QICore-Observation | QICore-AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

todo

This structure is derived from ImmunizationRecommendation.

Summary

Must-Support: 4 elements

Structures

This structure refers to these other structures:

• http://hl7.org/fhir/StructureDefinition/qicore-patient
• http://hl7.org/fhir/StructureDefinition/qicore-organization
• http://hl7.org/fhir/StructureDefinition/qicore-immunization
• http://hl7.org/fhir/StructureDefinition/qicore-observation
• http://hl7.org/fhir/StructureDefinition/qicore-allergyintolerance

Differential View

This structure is derived from ImmunizationRecommendation.

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation
patient	S	1..1	Reference(QICore-Patient)
recommendation		1..*	BackboneElement
date	S	1..1	dateTime
vaccineCode	S	1..1	CodeableConcept	Binding: Vaccine Administered Value Set (preferred)
doseNumber	S	0..1	positiveInt
protocol		0..1	BackboneElement
authority		0..1	Reference(QICore-Organization)
supportingImmunization		0..*	Reference(QICore-Immunization)
supportingPatientInformation		0..*	Reference(QICore-Observation | QICore-AllergyIntolerance)
Documentation for this format

Snapshot View

Name	Flags	Card.	Type	Description & Constraints
ImmunizationRecommendation		0..*	ImmunizationRecommendation	Guidance or advice relating to an immunization
meta	∑	0..1	Meta	Metadata about the resource
implicitRules	?! ∑	0..1	uri	A set of rules under which this content was created
language		0..1	code	Language of the resource content Binding: IETF BCP-47 (required)
text	I	0..1	Narrative	Text summary of the resource, for human interpretation
contained		0..*	Resource	Contained, inline Resources
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
identifier	∑	0..*	Identifier	Business identifier
patient	S ∑	1..1	Reference(QICore-Patient)	Who this profile is for
recommendation	∑	1..*	BackboneElement	Vaccine administration recommendations
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
date	S ∑	1..1	dateTime	Date recommendation created
vaccineCode	S ∑	1..1	CodeableConcept	Vaccine recommendation applies to Binding: Vaccine Administered Value Set (preferred)
doseNumber	S ∑	0..1	positiveInt	Recommended dose number
forecastStatus	∑	1..1	CodeableConcept	Vaccine administration status Binding: Immunization Recommendation Status Codes (example)
dateCriterion		0..*	BackboneElement	Dates governing proposed immunization
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
code		1..1	CodeableConcept	Type of date Binding: Immunization Recommendation Date Criterion Codes (example)
value		1..1	dateTime	Recommended date
protocol		0..1	BackboneElement	Protocol used by recommendation
extension		0..*	Extension	Additional Content defined by implementations
modifierExtension	?!	0..*	Extension	Extensions that cannot be ignored
doseSequence		0..1	integer	Dose number within sequence
description		0..1	string	Protocol details
authority		0..1	Reference(QICore-Organization)	Who is responsible for protocol
series		0..1	string	Name of vaccination series
supportingImmunization		0..*	Reference(QICore-Immunization)	Past immunizations supporting recommendation
supportingPatientInformation		0..*	Reference(QICore-Observation | QICore-AllergyIntolerance)	Patient observations supporting recommendation
Documentation for this format

XML Template

JSON Template

todo

Other representations of profile: Schematron

F.19.1.2 Terminology Bindings

Path	Name	Conformance	ValueSet
ImmunizationRecommendation.language	?ext	required	http://tools.ietf.org/html/bcp47
ImmunizationRecommendation.recommendation.vaccineCode	Vaccine Administered Value Set	preferred	Vaccine Administered Value Set
ImmunizationRecommendation.recommendation.forecastStatus	Immunization Recommendation Status Codes	example	Immunization Recommendation Status Codes
ImmunizationRecommendation.recommendation.dateCriterion.code	Immunization Recommendation Date Criterion Codes	example	Immunization Recommendation Date Criterion Codes

F.19.1.3 Constraints